Resource CapabilityStatement/FHIR Server from package nhs.england.rad#current (46 ms)

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
NRL-DocumentReference	NRL DocumentReference

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "FindDocumentsNRL",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement FindDocumentsNRL</b></p><a name=\"FindDocumentsNRL\"> </a><a name=\"hcFindDocumentsNRL\"> </a><a name=\"FindDocumentsNRL-en-GB\"> </a><h2 id=\"title\">Finding and Retrieving Document Entries NRL</h2><ul><li>Implementation Guide Version: 0.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-20 </li><li>Published by: NHS England </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Security</em></div><blockquote><div><p>See NRL API Documentation</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#DocumentReference1-1\">DocumentReference</a></td><td><a href=\"StructureDefinition-NRL-DocumentReference.html\">https://fhir.nhs.uk/England/RAD/StructureDefinition/NRL-DocumentReference</a><br/><em>Additional supported profiles:</em><br/>��<code>https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference</code></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>subject:identifier</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-NRL-DocumentReference.html\">NRL DocumentReference</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><code>https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference</code></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><h3>Read</h3>\n<pre><code>GET /DocumentReference/{id}\n</code></pre>\n<h4>Example</h4>\n<pre><code>GET /DocumentReference/5678\n</code></pre>\n<p>Example API response:</p>\n<ul>\n<li><a href=\"DocumentReference-DocumentReferenceRadiologyNRL.html\">DocumentReference NRL for Radiology</a></li>\n</ul>\n<h3>Search</h3>\n<pre><code>GET /DocumentReference?{parameters}\n</code></pre>\n<h4>Example</h4>\n<pre><code>GET /DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888\n</code></pre>\n<p>Example response:</p>\n<ul>\n<li><a href=\"Bundle-NRLSearchResultsDocuments.html\">Document Reference Search Results NRL</a></li>\n</ul>\n<p>Implementers <strong>SHALL</strong> also conform to <a href=\"https://simplifier.net/hl7fhirukcorer4/ukcore-documentreference\">UKCore-DocumentReference</a> and conformance to all profiles <strong>SHOULD</strong> be tested via <a href=\"https://hl7.org/fhir/R4/validation.html\">FHIR Validation</a>.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>subject:identifier</td><td><code>token</code></td><td><div><p>An Identifier for Who/what is the subject of the document</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
  },
  "url" : "https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindDocumentsNRL",
  "version" : "0.0.1-current",
  "name" : "FindDocumentsNRL",
  "title" : "Finding and Retrieving Document Entries NRL",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-04-20",
  "publisher" : "NHS England",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "NHS England",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "This is a local version of\n\n- [National Record Locator - FHIR API v3 - Retrieve document pointers (GET)](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer#get-/DocumentReference)\n- [National Record Locator - FHIR API v3 - Get a single document pointer](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer#get-/DocumentReference/-id-)\n\nfor documentation purposes.\n",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "security" : {
        "description" : "See NRL API Documentation"
      },
      "resource" : [
        {
          "type" : "DocumentReference",
          "profile" : "https://fhir.nhs.uk/England/RAD/StructureDefinition/NRL-DocumentReference",
          "supportedProfile" : [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference"
          ],
          "documentation" : "### Read\n\n```\nGET /DocumentReference/{id}\n```\n\n#### Example\n\n```\nGET /DocumentReference/5678\n```\n\nExample API response:\n\n- [DocumentReference NRL for Radiology](DocumentReference-DocumentReferenceRadiologyNRL.html)\n\n### Search\n\n```\nGET /DocumentReference?{parameters}\n```\n\n#### Example\n\n```\nGET /DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888\n```\n\nExample response:\n- [Document Reference Search Results NRL](Bundle-NRLSearchResultsDocuments.html)\n\nImplementers **SHALL** also conform to [UKCore-DocumentReference](https://simplifier.net/hl7fhirukcorer4/ukcore-documentreference) and conformance to all profiles **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).\n\n",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "subject:identifier",
              "type" : "token",
              "documentation" : "An Identifier for Who/what is the subject of the document"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.